QuintaDB REST API

QuintaDB REST API נועד לאפשר לך לנצל את מלוא הנתונים המאוחסנים במסד נתונים של QuintaDB. על ידי שימוש בממשק API זה אתה יכול להשיג יותר ממה שמציעה כיום QuintaDB. למעשה, אנו נותנים לך את הכוח לעשות כל מה שאתה צריך עם הנתונים שלך. לדוגמה, אתה יכול ליצור סקריפטים משלך, יישומי שולחן עבודה ו יישומים ניידים לפלטפורמות שונות כמו iPhone/Android ועוד. ו- QuintaDB יישאר שם, איפה אתה מאחסן, מנהל ומשתמש בנתונים שלך יחד עם אחרים.

מידע כללי על שיחות API

כל השיחות חייבות להכיל REST מפתח API , אשר ניתן למצוא על ידי לחיצה על כפתור ה "מפתחות API" בתחילת הדף.
ניתן לקבל את תגובת השרת בתבנית JSON או XML , בהתאם לבקשתך.
להלן אנו מציגים טבלאות עם תגובות שרת לכל בקשה. כתובות אתרים יוצגו כ /apps.json כלומר, עליכם להתקשר לשיטה באמצעות הקישור https://QuintaDB.ru /apps.json בתוכנית שלכם. שים לב ש כל השיחות חייבות להשתמש בפרוטוקול https ועליך לבדוק את תקפות אישור ה- SSL של השרת.

מסד נתונים

ניתן להשיג מאפייני מסד נתונים כאלה באמצעות ממשק ה- REST.

מזהה ייחודי למסד הנתונים

name

שם

created_at

הזמן בו נוצר בסיס הנתונים

updated_at

הזמן בו עודכן בסיס הנתונים

ראה את כל מסדי הנתונים

פרמטרים

rest_api_key

מפתח ה- API שלך

page

מסדי נתונים מוצגים 20 לעמוד, כלומר העמוד יכול להיות 1..5

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/apps.json

תוכן הבקשה

{"page":1,"rest_api_key":"API_KEY"}

תגובה: מחזיר את כל מסדי הנתונים

    
{"databases":[
{"id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Database Name 1",
 "created_at"      : "2021-08-16T05:42:40-05:00",
 "updated_at"      : "2021-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0
 },
{"id"              : "aOWO3eVXHdHie1WeGFE8k2"
 "name"            : "Database Name 2",
 "created_at"      : "2021-04-29T01:26:22-05:00",
 "updated_at"      : "2021-08-16T00:47:56-05:00",
 "dtypes_count"    : 768,
 "entities_count"  : 6,
 "properties_count": 240
} ]}

Making request (XML)

פורמט

XML

שיטה

GET

URL

/apps.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<page>1</page>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

תגובה: מחזיר את כל מסדי הנתונים

    
<?xml version="1.0" encoding="UTF-8"?>
<databases type="array">
  <database>
    <id>aOWO_dVXHdHie1WeGFE8k2</id>
    <name>Database name 1</name>
    <created-at type="datetime">2021-08-16T05:42:40-05:00</created-at>
    <updated-at type="datetime">2021-08-16T05:42:40-05:00</updated-at>
    <dtypes-count type="integer">0</dtypes-count>
    <entities-count type="integer">1</entities-count>
    <properties-count type="integer">0</properties-count>
  </database>
  <database>
    <id>aOWO3eVXHdHie1WeGFE8k2</id>
    <name>Database Name 2</name>
    <created-at type="datetime">2021-04-29T01:26:22-05:00</created-at>
    <updated-at type="datetime">2021-08-16T00:47:56-05:00</updated-at>
    <dtypes-count type="integer">768</dtypes-count>
    <entities-count type="integer">6</entities-count>
    <properties-count type="integer">240</properties-count>
  </database>
</databases>

קבל את מסד הנתונים לפי תעודת הזהות

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

אתה צריך לדעת את מזהה בסיס הנתונים שברצונך למחוק. אתה יכול למצוא את המזהה לאחר קבלת כל בסיסי הנתונים . לדעת את מזהה בסיס הנתונים, עליך לרשום את המזהה בכתובת האתר, לדוגמה:/apps/ID.json ב- /apps/aOWO_dVXHdHie1WeGFE8k2.json

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/apps/APP_ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY"}

תגובה: מחזיר מידע על בסיס נתונים

    
{"database":{
 "id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Database Name 1",
 "created_at"      : "2011-08-16T05:42:40-05:00",
 "updated_at"      : "2011-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0,
 "complex_app?"    : true,
 "complex_app_with_fresh_data?" : false
 }
}

Making request (XML)

פורמט

XML

שיטה

GET

URL

/apps/APP_ID.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

תגובה: מחזיר מידע על בסיס נתונים

    
<?xml version="1.0" encoding="UTF-8"?>
<database>
 <id>aOWO_dVXHdHie1WeGFE8k2</id>
 <name>Database name 1</name>
 <created-at type="datetime">2011-08-16T05:42:40-05:00</created-at>
 <updated-at type="datetime">2011-08-16T05:42:40-05:00</updated-at>
 <dtypes-count type="integer">0</dtypes-count>
 <entities-count type="integer">1</entities-count>
 <properties-count type="integer">0</properties-count>
</database>

קבל מסד נתונים לפי שם

פרמטרים

rest_api_key

מפתח ה- API שלך

שם

אתה צריך לדעת את שם בסיס הנתונים. ניתן להשיג את השם באמצעות שאילתות קבל את כל מסדי הנתונים ..

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/apps/search.json

תוכן הבקשה

{"rest_api_key":"API_KEY", "name":"Database Name 1"}

תגובה: מחזיר מידע על בסיס נתונים

    
{"database":{
 "id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Database Name 1",
 "created_at"      : "2021-08-16T05:42:40-05:00",
 "updated_at"      : "2021-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0,
 "complex_app?"    : true,
 "complex_app_with_fresh_data?" : false
 }
}

Making request (XML)

פורמט

XML

שיטה

GET

URL

/apps/search.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<rest_api_key>API_KEY</rest_api_key> <name>Database Name 1</name> </api_call_params>

תגובה: מחזיר מידע על בסיס נתונים

    
<?xml version="1.0" encoding="UTF-8"?>
<database>
 <id>aOWO_dVXHdHie1WeGFE8k2</id>
 <name>Database name 1</name>
 <created-at type="datetime">2021-08-16T05:42:40-05:00</created-at>
 <updated-at type="datetime">2021-08-16T05:42:40-05:00</updated-at>
 <dtypes-count type="integer">0</dtypes-count>
 <entities-count type="integer">1</entities-count>
 <properties-count type="integer">0</properties-count>
</database>

עדכן את בסיס הנתונים

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

name

שמו החדש של בסיס הנתונים

Making request (JSON)

פורמט

JSON

שיטה

PUT

URL

/apps/APP_ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY",
"name":"New database name"}

תגובה: מחזיר מידע על בסיס נתונים

    
{"database":{
 "id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "New database name",
 "created_at"      : "2021-08-16T05:42:40-05:00",
 "updated_at"      : "2021-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0,
 "complex_app?"    : true,
 "complex_app_with_fresh_data?" : false
 }
}

Making request (XML)

פורמט

XML

שיטה

PUT

URL

/apps/APP_ID.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<name>New database name</rest_api_key>
</api_call_params>

תגובה: מחזיר מידע על בסיס נתונים

    
<?xml version="1.0" encoding="UTF-8"?>
<database>
 <id>aOWO_dVXHdHie1WeGFE8k2</id>
 <name>New database name</name>
 <created-at type="datetime">2021-08-16T05:42:40-05:00</created-at>
 <updated-at type="datetime">2021-08-16T05:42:40-05:00</updated-at>
 <dtypes-count type="integer">0</dtypes-count>
 <entities-count type="integer">1</entities-count>
 <properties-count type="integer">0</properties-count>
</database>

מחק את בסיס הנתונים

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

Making request (JSON)

פורמט

JSON

שיטה

DELETE

URL

/apps/APP_ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY"}

תגובה

    
{"databases":[{
 "id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Database Name 1",
 "created_at"      : "2011-08-16T05:42:40-05:00",
 "updated_at"      : "2011-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0
 },
{"id"              : "aOWO3eVXHdHie1WeGFE8k2"
 "name"            : "Database Name 2",
 "created_at"      : "2011-04-29T01:26:22-05:00",
 "updated_at"      : "2011-08-16T00:47:56-05:00",
 "dtypes_count"    : 768,
 "entities_count"  : 6,
 "properties_count": 240
} ]}

Making request (XML)

פורמט

XML

שיטה

DELETE

URL

/apps/APP_ID.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
<databases type="array">
 <database>
   <id>aOWO_dVXHdHie1WeGFE8k2</id>
   <name>Database name 1</name>
   <created-at type="datetime">2011-08-16T05:42:40-05:00</created-at>
   <updated-at type="datetime">2011-08-16T05:42:40-05:00</updated-at>
   <dtypes-count type="integer">0</dtypes-count>
   <entities-count type="integer">1</entities-count>
   <properties-count type="integer">0</properties-count>
 </database>
 <database>
   <id>aOWO3eVXHdHie1WeGFE8k2</id>
   <name>Database Name 2</name>
   <created-at type="datetime">2011-04-29T01:26:22-05:00</created-at>
   <updated-at type="datetime">2011-08-16T00:47:56-05:00</updated-at>
   <dtypes-count type="integer">768</dtypes-count>
   <entities-count type="integer">6</entities-count>
   <properties-count type="integer">240</properties-count>
 </database>
</databases>

לאחר מחיקת בסיס הנתונים, שיטה זו מחזירה את כל בסיסי הנתונים שנותרו.

צור פרויקט

פרמטרים

rest_api_key

מפתח ה- API שלך

database_name

שם בסיס הנתונים

form_name

שם הטופס. לא ניתן ליצור בסיס נתונים ללא טופס מכיוון שאין נקודה במסד נתונים ללא טופס.

Making request (JSON)

פורמט

JSON

שיטה

POST

URL

/apps.json

תוכן הבקשה

{"rest_api_key":"API_KEY", database_name: "Database 1", form_name: "Form 1"}

תגובה: מחזיר מידע על בסיס נתונים

    
{"database":
   {"id"              : "aOWO_dVXHdHie1WeGFE8k2"
    "name"            : "Database Name 1",
    "created_at"      : "2011-08-16T05:42:40-05:00",
    "updated_at"      : "2011-08-16T05:42:40-05:00",
    "dtypes_count"    : 0,
    "entities_count"  : 1,
    "properties_count": 0
    }
}

Making request (XML)

פורמט

XML

שיטה

POST

URL

/apps.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<rest_api_key>API_KEY</rest_api_key> <database_name>Database 1</database_name> <form_name>Form 1</form_name> </api_call_params>

תגובה: מחזיר מידע על בסיס נתונים

    
  <?xml version="1.0" encoding="UTF-8"?>
    <database>
      <id>aOWO_dVXHdHie1WeGFE8k2</id>
      <name>Database name 1</name>
      <created-at type="datetime">2011-08-16T05:42:40-05:00</created-at>
      <updated-at type="datetime">2011-08-16T05:42:40-05:00</updated-at>
      <dtypes-count type="integer">0</dtypes-count>
      <entities-count type="integer">1</entities-count>
      <properties-count type="integer">0</properties-count>
    </database>

במקרה של שגיאה. תקבל הודעת שגיאה, כלומר 'שם יישום כזה כבר קיים'.

טופס

תכונות צורה ניתן להשיג באמצעות ממשק API REST.

מזהה ייחודי לטופס

name

שם

desc

תיאור

post_action

ל: רשימת נמעני הדואל

קבל טפסים כלשהם

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/apps/APP_ID/entities.json

תוכן הבקשה

{rest_api_key":"API_KEY"}

תגובה: קבל את כל טופסי בסיס הנתונים

    
{"forms":[
 {
 "id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
 },
 {
 "id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      } ]}

Making request (XML)

פורמט

XML

שיטה

GET

URL

/apps/APP_ID/entities.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

תגובה: קבל את כל טופסי בסיס הנתונים

    
<?xml version="1.0" encoding="UTF-8"?>
<forms type="array">
<form>
<id>c7zH3cKWrnqQvbrG8Nd3C7</id>
<app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
<name>Form1</name>
<desc nil="true"></desc>
<post-action>igor.petrushenko@gmail.com</post-action>
<position type="integer">0</position>
<sort-by nil="true"></sort-by>
<asc type="boolean">false</asc>
<per-page type="integer">10</per-page>
<allow-delete type="boolean">false</allow-delete>
<new-widget nil="true"></new-widget>
<records-widget nil="true"></records-widget>
<target-page nil="true"></target-page>
<allow-database type="boolean">true</allow-database>
<send-emails type="boolean">true</send-emails>
<settings nil="true"></settings>
</form>
<form>
<id>aszH3cKWrnqQvbrG8Nd3C7</id>
<app-id>ddFSkDDdncMyoKjGnWFmoE</app-id>
<name>Form2</name>
<desc nil="true"></desc>
<post-action>igor.petrushenko@gmail.com</post-action>
<position type="integer">0</position>
<sort-by nil="true"></sort-by>
<asc type="boolean">false</asc>
<per-page type="integer">10</per-page>
<allow-delete type="boolean">false</allow-delete>
<new-widget nil="true"></new-widget>
<records-widget nil="true"></records-widget>
<target-page nil="true"></target-page>
<allow-database type="boolean">true</allow-database>
<send-emails type="boolean">true</send-emails>
<settings nil="true"></settings>
</form>
</forms>

מחזיר מידע על טפסים

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

אתה צריך לדעת את מזהה הטופס. אתה יכול למצוא את ENTITY_ID לאחר קבלת כל הטפסים . לדעת את מזהה הטופס, אתה צריך להחליף את ENTITY_ID בכתובת האתר, למשל:/apps/APP_ID/ישויות. json ב- /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/apps/APP_ID/entities/ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY"}

תגובה: returns form information

    
{"form":   
{"id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      }
}

Making request (XML)

פורמט

XML

שיטה

GET

URL

/apps/APP_ID/entities/ID.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

תגובה: returns form information

    
<?xml version="1.0" encoding="UTF-8"?>
<form>
 <id>c7zH3cKWrnqQvbrG8Nd3C7</id>
 <app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
 <name>Form1</name>
 <desc nil="true"></desc>
 <post-action>igor.petrushenko@gmail.com</post-action>
 <position type="integer">0</position>
 <sort-by nil="true"></sort-by>
 <asc type="boolean">false</asc>
 <per-page type="integer">10</per-page>
 <allow-delete type="boolean">false</allow-delete>
 <new-widget nil="true"></new-widget>
 <records-widget nil="true"></records-widget>
 <target-page nil="true"></target-page>
 <allow-database type="boolean">true</allow-database>
 <send-emails type="boolean">true</send-emails>
 <settings nil="true"></settings>
</form>

קבל טופס לפי שם

פרמטרים

rest_api_key

מפתח ה- API שלך

database_name

אתה צריך לדעת את שם בסיס הנתונים. ניתן להשיג את השם באמצעות שאילתות קבל את כל מסדי הנתונים ..

form_name

אתה צריך לדעת את שם הטופס. ניתן להשיג זאת באמצעות חיבור קבל את כל הטפסים .

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/apps/search/entities/search.json

תוכן הבקשה

{"rest_api_key":"API_KEY", "database_name": "Database 21", "form_name": "Form Name 1"}

תגובה: returns form information

    
{"form":   
{"id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      }
}

Making request (XML)

פורמט

XML

שיטה

GET

URL

/apps/search/entities/search.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<database_name>Database 21</database_name>
<form_name>Form1</form_name>
</api_call_params>

תגובה: returns form information

    
<?xml version="1.0" encoding="UTF-8"?>
<form>
 <id>c7zH3cKWrnqQvbrG8Nd3C7</id>
 <app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
 <name>Form1</name>
 <desc nil="true"></desc>
 <post-action>igor.petrushenko@gmail.com</post-action>
 <position type="integer">0</position>
 <sort-by nil="true"></sort-by>
 <asc type="boolean">false</asc>
 <per-page type="integer">10</per-page>
 <allow-delete type="boolean">false</allow-delete>
 <new-widget nil="true"></new-widget>
 <records-widget nil="true"></records-widget>
 <target-page nil="true"></target-page>
 <allow-database type="boolean">true</allow-database>
 <send-emails type="boolean">true</send-emails>
 <settings nil="true"></settings>
</form>

עדכן את הטופס

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

name

השם החדש של הטופס. ראה את כל האפשרויות הזמינות כאן

Making request (JSON)

פורמט

JSON

שיטה

PUT

URL

/apps/APP_ID/entities/ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY",
"name":"New form name"}

תגובה: returns form information

    
{"form":   
{   
"id"              : "aOWO_dVXHdHie1WeGFE8k2",
"app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
"name"            : "New form name",
"desc"            : "Form description",
"post_action"     : "email@email.com",
"position"        : 0,
"sort_by"         : null,
"asc"             : false,
"per_page"        : 10,
"allow_delete"    : false,
"new_widget"      : null,
"records_widget"  : null,
"target_page"     : null,
"allow_database"  : true,
"send_emails"     : true,
"settings"        : null
     }
}

Making request (XML)

פורמט

XML

שיטה

PUT

URL

/apps/APP_ID/entities/ID.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<name>New form name</name>
</api_call_params>

תגובה: returns form information

    
<?xml version="1.0" encoding="UTF-8"?>
<form>
 <id>c7zH3cKWrnqQvbrG8Nd3C7</id>
 <app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
 <name>New form name</name>
 <desc nil="true"></desc>
 <post-action>igor.petrushenko@gmail.com</post-action>
 <position type="integer">0</position>
 <sort-by nil="true"></sort-by>
 <asc type="boolean">false</asc>
 <per-page type="integer">10</per-page>
 <allow-delete type="boolean">false</allow-delete>
 <new-widget nil="true"></new-widget>
 <records-widget nil="true"></records-widget>
 <target-page nil="true"></target-page>
 <allow-database type="boolean">true</allow-database>
 <send-emails type="boolean">true</send-emails>
 <settings nil="true"></settings>
</form>

מחק טופס

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

אתה צריך לדעת את מזהה הטופס שברצונך למחוק. אתה יכול למצוא את המזהה לאחר קבלת כל הטפסים . לדעת את מזהי הטפסים, עליך להזכיר את המזהה בכתובת האתר, למשל:/apps/APP_ID /entities/ID.json ב /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2.json

Making request (JSON)

פורמט

JSON

שיטה

DELETE

URL

/apps/APP_ID/entities/ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY"}

תגובה

    
{"forms":[{"id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
       },
      {  "id"      : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      } ]}

Making request (XML)

פורמט

XML

שיטה

DELETE

URL

/apps/APP_ID/entities/ID.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
<forms type="array">
<form>
<id>c7zH3cKWrnqQvbrG8Nd3C7</id>
<app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
<name>Form1</name>
<desc nil="true"></desc>
<post-action>igor.petrushenko@gmail.com</post-action>
<position type="integer">0</position>
<sort-by nil="true"></sort-by>
<asc type="boolean">false</asc>
<per-page type="integer">10</per-page>
<allow-delete type="boolean">false</allow-delete>
<new-widget nil="true"></new-widget>
<records-widget nil="true"></records-widget>
<target-page nil="true"></target-page>
<allow-database type="boolean">true</allow-database>
<send-emails type="boolean">true</send-emails>
<settings nil="true"></settings>
</form>
<form>
<id>aszH3cKWrnqQvbrG8Nd3C7</id>
<app-id>ddFSkDDdncMyoKjGnWFmoE</app-id>
<name>Form2</name>
<desc nil="true"></desc>
<post-action>igor.petrushenko@gmail.com</post-action>
<position type="integer">0</position>
<sort-by nil="true"></sort-by>
<asc type="boolean">false</asc>
<per-page type="integer">10</per-page>
<allow-delete type="boolean">false</allow-delete>
<new-widget nil="true"></new-widget>
<records-widget nil="true"></records-widget>
<target-page nil="true"></target-page>
<allow-database type="boolean">true</allow-database>
<send-emails type="boolean">true</send-emails>
<settings nil="true"></settings>
</form>
</forms>

צור טופס

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

name

שם טופס

Making request (JSON)

פורמט

JSON

שיטה

POST

URL

/apps/APP_ID/entities.json

תוכן הבקשה

{"rest_api_key":"API_KEY", name: "New form"}

תגובה: returns form information

    
{"form":   
{   
 "id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "New form",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      }
}

Making request (XML)

פורמט

XML

שיטה

POST

URL

/apps/APP_ID/entities.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<name>New form</rest_api_key>
</api_call_params>

תגובה: returns form information

    
<?xml version="1.0" encoding="UTF-8"?>
<form>
 <id>c7zH3cKWrnqQvbrG8Nd3C7</id>
 <app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
 <name>New form</name>
 <desc nil="true"></desc>
 <post-action>igor.petrushenko@gmail.com</post-action>
 <position type="integer">0</position>
 <sort-by nil="true"></sort-by>
 <asc type="boolean">false</asc>
 <per-page type="integer">10</per-page>
 <allow-delete type="boolean">false</allow-delete>
 <new-widget nil="true"></new-widget>
 <records-widget nil="true"></records-widget>
 <target-page nil="true"></target-page>
 <allow-database type="boolean">true</allow-database>
 <send-emails type="boolean">true</send-emails>
 <settings nil="true"></settings>
</form>

שדה

תכונות שדה ניתן להשיג באמצעות ממשק ה- API של REST.

המזהה הייחודי של השדה

entity_id

Field's form identifier.

name

שם

type_name

סוג השדה. אולי: string, text, integer, float, select, radio button, check box, date, dob, datetime, file, image, boolean, language, states, table, country, time_zone, note, divider, formula, autoincrement, login, password, signature, linked_column, rel, subform

קבל שדות טופס

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

ENTITY_ID

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/apps/APP_ID/entities/ENTITY_ID/properties.json

תוכן הבקשה

{rest_api_key":"API_KEY"}

תגובה: קבל את כל שדות הטופס

    
{"fields":[
{"id"               : "aOWO_dVXHdHie1WeGFE8k2",
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 },
{"id"               : "1i2i4VXHdHie1WeGFE8k2" ,
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 }
  ]}

Making request (XML)

פורמט

XML

שיטה

GET

URL

/apps/APP_ID/entities/ENTITY_ID/properties.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

תגובה: קבל את כל שדות הטופס

    
<?xml version="1.0" encoding="UTF-8"?>
<fields type="array">
<field>
  <id>clrSoltHDdQyozW5NcLrGd</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test</name>
  <desc nil="true"></desc>
  <type-name>string</type-name>
  <default></default>
  <validate-options></validate-options>
  <position type="integer">0</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>
<field>
  <id>ddUHDhCgzeW6HkW4NdG3vE</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test2</name>
  <desc nil="true"></desc>
  <type-name>select</type-name>
  <default>1slct2slct3slct4slct5</default>
  <validate-options></validate-options>
  <position type="integer">1</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>
</fields>

קבל שדה

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

ENTITY_ID

אתה צריך לדעת את מזהה השדה. אתה יכול למצוא את המזהה לאחר קבלת כל שדות הטופס . מכיר את מזהה השדה, עליך להזכיר את המזהה בכתובת האתר, למשל:/apps/APP_ID/ישויות/ENTITY_ID/Properties/ID.json ל- /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY"}

תגובה

    
{"field":  
{
"id"               : "aOWO_dVXHdHie1WeGFE8k2",
"entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
"name"             : "Field Name 1",
"desc"             : "Field description",
"type_name"        : "string",
"default"          : "default value",
"validate_options" : "",
"position"         : 0,
"visible"          : true,
"size": 50,
"cols": 43,
"rows": 10
}
}

Making request (XML)

פורמט

XML

שיטה

GET

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
<field>
 <id>clrSoltHDdQyozW5NcLrGd</id>
 <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
 <name>test</name>
 <desc nil="true"></desc>
 <type-name>string</type-name>
 <default></default>
 <validate-options></validate-options>
 <position type="integer">0</position>
 <visible type="boolean">true</visible>
 <size type="integer">50</size>
 <cols type="integer">43</cols>
 <rows type="integer">10</rows>
</field>

קבל שדה עם שם

פרמטרים

rest_api_key

מפתח ה- API שלך

database_name

אתה צריך לדעת את שם בסיס הנתונים. ניתן להשיג את השם באמצעות שאילתות קבל את כל מסדי הנתונים ..

form_name

אתה צריך לדעת את שם הטופס. ניתן להשיג זאת באמצעות חיבור קבל את כל הטפסים .

field_name

אתה צריך לדעת את שם השדה. ניתן להשיג זאת באמצעות קבל את כל שדות הטופס .

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/apps/search/entities/search/properties/search.json

תוכן הבקשה

{"rest_api_key":"API_KEY", "database_name": "Database 21", "form_name": "Form Name 1", "field_name": "Field Name 1"}

תגובה

    
{"field":  
{"id"               : "aOWO_dVXHdHie1WeGFE8k2",
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 }
}

Making request (XML)

פורמט

XML

שיטה

GET

URL

/apps/search/entities/search/properties/search.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<database_name>Database 21</database_name>
<form_name>Form1</form_name>
<field_name>test</field_name>
</api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
<field>
  <id>clrSoltHDdQyozW5NcLrGd</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test</name>
  <desc nil="true"></desc>
  <type-name>string</type-name>
  <default></default>
  <validate-options></validate-options>
  <position type="integer">0</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>

הפעל פעולה

פרמטרים

rest_api_key

מפתח ה- API שלך

DTYPE_ID

עליך לדעת את מזהה הרשומות שלך. אתה יכול למצוא מזהה באמצעות שיחת אחזר כל הרשומות.

ACTION_PROPERTY_ID

עליך לדעת את מזהה השדה שלך. אתה יכול למצוא מזהה באמצעות הקריאה אחזר את כל שדות הטופס.

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/actions/ACTION_PROPERTY_ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY", "dtype_id": "DTYPE_ID"}

תגובה

    
{\"success\":\"Done\"}

Making request (XML)

פורמט

XML

שיטה

GET

URL

/actions/ACTION_PROPERTY_ID.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<dtype_id>DTYPE_ID</dtype_id>
</api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

הפעל פעולות

פרמטרים

rest_api_key

מפתח ה- API שלך

ACTION_PROPERTY_ID

עליך לדעת את מזהה השדה שלך. אתה יכול למצוא מזהה באמצעות הקריאה אחזר את כל שדות הטופס.

dtype_ids

עליך לדעת את מזהי הרשומות שלך. אתה יכול למצוא מזהה באמצעות שיחת אחזר כל הרשומות.

json_dtype_ids

עליך לדעת את מזהי הרשומות שלך. אתה יכול למצוא מזהה באמצעות שיחת אחזר כל הרשומות.

run_by_all_table_or_report

הפרמטר הבא זמין להפעלת כל הפעולות בטבלה או בדוח: run_by_all_table_or_report=true.

view

כדי לקבל רשומות, עליך לדעת את מזהה הדוח. (לא בהכרח)

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/actions/ACTION_PROPERTY_ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY", "dtype_ids": ["ID1","ID2"...]}

{"rest_api_key":"API_KEY", "json_dtype_ids": "[\"ID1\",\"ID2\"...]"}

{"rest_api_key":"API_KEY", "run_by_all_table_or_report": true}

תגובה

    
{\"success\":\"Done\"}

Making request (XML)

פורמט

XML

שיטה

GET

URL

/actions/ACTION_PROPERTY_ID.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<dtype_ids>"ID1","ID2"...</dtype_ids>
</api_call_params>

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<json_dtype_ids>"[\"ID1\",\"ID2\"...]"</json_dtype_ids>
</api_call_params>

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<run_by_all_table_or_report>true</run_by_all_table_or_report>
</api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

עדכן את השדה

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

ENTITY_ID

name

שם השדה החדש. ניתן למצוא את כל התכונות הזמינות כאן

Making request (JSON)

פורמט

JSON

שיטה

PUT

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY",
"name":"New field name"}

תגובה

    
{"field":  
{"id"              : "aOWO_dVXHdHie1WeGFE8k2",
"entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
"name"             : "Field Name 1",
"desc"             : "Field description",
"type_name"        : "string",
"default"          : "default value",
"validate_options" : "",
"position"         : 0,
"visible"          : true,
"size": 50,
"cols": 43,
"rows": 10
}
}

Making request (XML)

פורמט

XML

שיטה

PUT

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<name>New field name</rest_api_key>
</api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
<field>
  <id>clrSoltHDdQyozW5NcLrGd</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test</name>
  <desc nil="true"></desc>
  <type-name>string</type-name>
  <default></default>
  <validate-options></validate-options>
  <position type="integer">0</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>

מחק שדה

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

ENTITY_ID

Making request (JSON)

פורמט

JSON

שיטה

DELETE

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY"}

תגובה

    
{"fields":[
{"id"               : "aOWO_dVXHdHie1WeGFE8k2",
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 },
{"id"               : "1i2i4VXHdHie1WeGFE8k2" ,
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 }
  ]}

Making request (XML)

פורמט

XML

שיטה

DELETE

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
<fields type="array">
<field>
  <id>clrSoltHDdQyozW5NcLrGd</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test</name>
  <desc nil="true"></desc>
  <type-name>string</type-name>
  <default></default>
  <validate-options></validate-options>
  <position type="integer">0</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>
<field>
  <id>ddUHDhCgzeW6HkW4NdG3vE</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test2</name>
  <desc nil="true"></desc>
  <type-name>select</type-name>
  <default>1slct2slct3slct4slct5</default>
  <validate-options></validate-options>
  <position type="integer">1</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>
</fields>

צור שדה

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

ENTITY_ID

name

שם שדה

type_name

Making request (JSON)

פורמט

JSON

שיטה

POST

URL

/apps/APP_ID/entities/ENTITY_ID/properties.json

תוכן הבקשה

{"rest_api_key":"API_KEY", name: "Field name 1", type_name: "string"}

תגובה: returns form information

    
{"field": 
{"id"               : "aOWO_dVXHdHie1WeGFE8k2",
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 }
}

Making request (XML)

פורמט

XML

שיטה

POST

URL

/apps/APP_ID/entities/ENTITY_ID/properties.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<name>Form field 1</name>
<type-name>string</type-name>
</api_call_params>

תגובה: returns form information

    
<?xml version="1.0" encoding="UTF-8"?>
  <field>
    <id>clrSoltHDdQyozW5NcLrGd</id>
    <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
    <name>test</name>
    <desc nil="true"></desc>
    <type-name>string</type-name>
    <default></default>
    <validate-options></validate-options>
    <position type="integer">0</position>
    <visible type="boolean">true</visible>
    <size type="integer">50</size>
    <cols type="integer">43</cols>
    <rows type="integer">10</rows>
  </field>
</field>

קבל סיכומים בעמודה

פרמטרים

rest_api_key

מפתח ה- API שלך

ENTITY_ID

view

כדי לקבל רשומות, עליך לדעת את מזהה הדוח. (לא בהכרח)

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/search/sum/ENTITY_ID/ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY",
view: "ImWO3eVXHdHie1WeGFE8k2"}

תגובה

    
{total: 3}

Making request (XML)

פורמט

XML

שיטה

GET

URL

/search/sum/ENTITY_ID/ID.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<view>ImWO3eVXHdHie1WeGFE8k2</view>
</api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
<total>
 3
</total>

הקלט

ניתן להשיג תכונות צריבה דרך ממשק ה- REST.

מזהה ייחודי עבור הרשומה.

app_id

מזהה פרוייקט

entity_id

מזהה של טופס הרשומה.

values

חיסכון בערכי שמירה. כאשר המפתח הוא מזהה שדה והערך הוא ערך השדה.

json_values

רשומה של ערכי hash. כאשר המפתח הוא מזהה שדה והערך הוא ערך השדה הזה. אנלוגי של values_hash אך בפורמט JSON

rel_values

ערך הערך של יחסי הכתיבה. כאשר המפתח הוא מזהה שדה והערך הוא מזהה הרשומה המשויך.

קבל רשומות

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

ENTITY_ID

view

כדי לקבל רשומות, עליך לדעת את מזהה הדוח. (לא בהכרח)

page

רשום מספר עמוד. ממספר רשומות/ לכל דף .

name_value

השתמש בפרמטר כדי להשיג רשומות של הטופס: "שם שדה": "ערך", "שדה מזהה": "שם שדה"

fetch_all

עבור בעלים של חשבונות בתשלום, הפרמטר הבא זמין: fetch_all=true.
כדי לקבל מספר מסוים של פוסטים, השתמש בפרמטר per_page.
הגבלות על המספר המרבי של כניסות per_page עבור תוכניות שונות:
FREE - 200
STANDARD - 500
PROFESSIONAL - 1000
ENTERPRISE - 2000
STANDARD EXPRESS - 4000
PROFESSIONAL EXPRESS - 8000
ENTERPRISE EXPRESS - 15000

גוף הבקשה
{"rest_api_key":"API_KEY", "page": 1, "name_value": 1, "view": 'EaWQZdIXfahOqWvcvwrGTP', "fetch_all": true, "per_page": 2000}

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/apps/APP_ID/dtypes/entity/ENTITY_ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY", "page": 1, "name_value": 1, "view": 'EaWQZdIXfahOqWvcvwrGTP'}

תגובה

    
{"records":[
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"value name 1":"2",
"aNW4nkW5bdUjldO8oKuSku":"value name 1",
"value name 2":"aaa",
"aMW4HKWR9bnOoGWQbpWQS4":"value name 2",
"value name 3":"ddd",
"cMW6pcTSjbWOFdTCkBtmkN":"value name 3"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
},
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"value name 1":"2",
"aNW4nkW5bdUjldO8oKuSku":"value name 1",
"value name 2":"aaa",
"aMW4HKWR9bnOoGWQbpWQS4":"value name 2",
"value name 3":"ddd",
"cMW6pcTSjbWOFdTCkBtmkN":"value name 3"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
]
}

Making request (XML)

פורמט

XML

שיטה

GET

URL

/apps/APP_ID/dtypes/entity/ENTITY_ID.json

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<view>EaWQZdIXfahOqWvcvwrGTP</view>
</api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
<records type="array">
<record>
<id>bYWQnuBajdBOkAW4BdMmki</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<values>
  <aNW4nkW5bdUjldO8oKuSku>2</aNW4nkW5bdUjldO8oKuSku>
  <aMW4HKWR9bnOoGWQbpWQS4>aaa</aMW4HKWR9bnOoGWQbpWQS4>
  <cMW6pcTSjbWOFdTCkBtmkN>ddd</cMW6pcTSjbWOFdTCkBtmkN>
</values>
<approved type="boolean">false</approved>
<created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
<updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>
<record>
<id>dcQSkdWO1odA5HAmkYWOix</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<values>
  <aNW4nkW5bdUjldO8oKuSku>1</aNW4nkW5bdUjldO8oKuSku>
  <aMW4HKWR9bnOoGWQbpWQS4>test</aMW4HKWR9bnOoGWQbpWQS4>
  <cMW6pcTSjbWOFdTCkBtmkN>test2</cMW6pcTSjbWOFdTCkBtmkN>
</values>
<approved type="boolean">false</approved>
<created-at type="datetime">2011-09-17T04:28:10-05:00</created-at>
<updated-at type="datetime">2011-09-17T04:28:10-05:00</updated-at>
</record>
</records>

קבל רשומה

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

אתה צריך לדעת את מזהה הרשומה. ניתן למצוא את המזהה לאחר קבלת כל הרשומות . לדעת את המזהה, עליך לרשום את המזהה בכתובת האתר, לדוגמה:/apps/APP_ID/dtypes/ID. json ב- /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

name_value

השתמש בפרמטר כדי להשיג רשומות של הטופס: "שם שדה": "ערך", "שדה מזהה": "שם שדה"

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/apps/APP_ID/dtypes/ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY", "name_value": 1}

תגובה

    
{"record":
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"value name 1":"2",
"aNW4nkW5bdUjldO8oKuSku":"value name 1",
"value name 2":"aaa",
"aMW4HKWR9bnOoGWQbpWQS4":"value name 2",
"value name 3":"ddd",
"cMW6pcTSjbWOFdTCkBtmkN":"value name 3"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
}

Making request (XML)

פורמט

XML

שיטה

GET

URL

/apps/APP_ID/dtypes/ID.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
<record>
<id>bYWQnuBajdBOkAW4BdMmki</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<values>
  <aNW4nkW5bdUjldO8oKuSku>2</aNW4nkW5bdUjldO8oKuSku>
  <aMW4HKWR9bnOoGWQbpWQS4>aaa</aMW4HKWR9bnOoGWQbpWQS4>
  <cMW6pcTSjbWOFdTCkBtmkN>ddd</cMW6pcTSjbWOFdTCkBtmkN>
</values>
<approved type="boolean">false</approved>
<created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
<updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>

עדכן רשומה

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

values

Hash של ערכי הרשומה שבהם המפתח הוא מזהה שדה הטופס

json_values

אם אתה משתמש ב- jQuery, רובי או בשפת תכנות אחרת כלשהי, אז אנא הכנס את ערכי הרשומה כמו hash המקודד בפרמטר 'ערכים'. אבל אם המסגרת שלך לא מאפשרת זאת, אתה יכול לשלוח את ערכי הרשומה, JSON, למשל: " {"aNW4nkW5bdUjldO8oKuSku ": "2 ", "aMW4HKWR9bnOoGWQbpWQS4 ": "aaa "} ". אך לאחר מכן השתמש בשם הפרמטר 'json_values'.

subforms_values / subforms_json_values

ליצירה או עדכון של טפסים המשנה, כמו כן, השתמש ב'תצורות המשנה_ערכים 'או 'json_subforms_values'.
הפורמט הבא:
"{property1_id: {entity_id: subform1_id, subform1_record1_id: {subform1_field1_id: "2 ", subform1_field2_id: "aaa "}, subform1_record2_id: {subform1_field1_id: "3 ", subform1_field2_id: "bb "}}, property2_id: {entity_id: subform2_id, subform2_record1_id: {subform2_field1_id: "4 ", subform2_field2_id: "bb "}, subform2_record2_id: {subform2_field1_id: "5 ", subform2_field2_id: "dd "}}} ".

איפה property1_id ו- property2_id - הוא המזהה של שדות טופס משנה בטבלה הראשית.
subform1_id, subform2_id - מזהה של הטופס, המצוין על ידי השדות property1_id ו- property2_id.
subform1_record1_id ו- subform1_record2_id - זהו מזהה הרשומות החדשות או הקיימות בטופס המשנה.
subform1_field1_id, subform1_field2_id - מזהה שדות בתתform1_id.
subform2_field1_id, subform2_field2_id - מזהה שדות בתתform2_id.

כל המזהים הם עם קודי בסיס64 בטוחים עם 22 תווים, אתה יכול לקחת אותם מממשקי API לחיבור אחרים או ליצור משלך למזהי רשומות חדשות.

Making request (JSON)

פורמט

JSON

שיטה

PUT

URL

/apps/APP_ID/dtypes/ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY", "values": {"aNW4nkW5bdUjldO8oKuSku" : 3, "aMW4HKWR9bnOoGWQbpWQS4" : "b", "cMW6pcTSjbWOFdTCkBtmkN" : "c"}}

תגובה

    
{"record":
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"aNW4nkW5bdUjldO8oKuSku":"3",
"aMW4HKWR9bnOoGWQbpWQS4":"b",
"cMW6pcTSjbWOFdTCkBtmkN":"c"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
}

Making request (XML)

פורמט

XML

שיטה

PUT

URL

/apps/APP_ID/dtypes/ID.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<values>{"aNW4nkW5bdUjldO8oKuSku"=>3, "aMW4HKWR9bnOoGWQbpWQS4"=>"b", "cMW6pcTSjbWOFdTCkBtmkN"=>"c"}</values> <rest_api_key>API_KEY</rest_api_key> </api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
<record>
<id>bYWQnuBajdBOkAW4BdMmki</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<values>
  <aNW4nkW5bdUjldO8oKuSku>3</aNW4nkW5bdUjldO8oKuSku>
  <aMW4HKWR9bnOoGWQbpWQS4>b</aMW4HKWR9bnOoGWQbpWQS4>
  <cMW6pcTSjbWOFdTCkBtmkN>c</cMW6pcTSjbWOFdTCkBtmkN>
</values>
<approved type="boolean">false</approved>
<created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
<updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>

עדכן כמה רשומות

פרמטרים

rest_api_key

מפתח ה- API שלך

confirm_action

הפרמטר הבא נדרש כדי להפעיל עדכון בטבלה או בדוח: confirm_action: update.

ENTITY_ID

עליך לדעת את מזהה הטופס של השדה שלך כדי לעדכן את הגדרות השדה. אתה יכול למצוא את ENTITY_ID באמצעות הקריאה אחזר את כל הטפסים.

APP_ID

עליך לדעת את מזהה מסד הנתונים שלך כדי להביא מידע על מסד הנתונים. אתה יכול למצוא מזהה באמצעות הקריאה אחזר את כל מסדי הנתונים.

dtype_ids

עליך לדעת את מזהי הרשומות שלך. אתה יכול למצוא מזהה באמצעות שיחת אחזר כל הרשומות.

json_dtype_ids

עליך לדעת את מזהי הרשומות שלך. אתה יכול למצוא מזהה באמצעות שיחת אחזר כל הרשומות.

update_id

עליך לדעת את מזהה השדה שלך. אתה יכול למצוא מזהה באמצעות הקריאה אחזר את כל שדות הטופס.

update_term

ערך חדש לרשומות

view

כדי לקבל רשומות, עליך לדעת את מזהה הדוח. (לא בהכרח)

Making request (JSON)

פורמט

JSON

שיטה

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

תוכן הבקשה

{rest_api_key: "YOUR_KEY",
confirm_action: "update",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
json_dtype_ids: "[\"ID1\",\"ID2\"...]",
update_id: "UPDATE_ID",
update_term: "UPDATE_TERM"}

{rest_api_key: "YOUR_KEY",
confirm_action: "update",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
dtype_ids: ["ID1","ID2"...],
update_id: "UPDATE_ID",
update_term: "UPDATE_TERM"}

תגובה

    
{\"success\":\"Done\"}

Making request (XML)

פורמט

XML

שיטה

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

תוכן הבקשה


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <confirm_action>update</confirm_action>
    <entity_id>ENTITY_ID</entity_id>
    <app_id>APP_ID</app_id>
    <dtype_ids>"ID1","ID2"...</dtype_ids>
    <update_id>UPDATE_ID</update_id>
    <update_term>UPDATE_TERM</update_term>
  </api_call_params>


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <confirm_action>update</confirm_action>
    <entity_id>ENTITY_ID</entity_id>
    <app_id>APP_ID</app_id>
    <json_dtype_ids>"[\"ID1\",\"ID2\"...]"</json_dtype_ids>
    <update_id>UPDATE_ID</update_id>
    <update_term>UPDATE_TERM</update_term>
  </api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

עדכן את כל הרשומות

פרמטרים

rest_api_key

מפתח ה- API שלך

confirm_action

הפרמטר הבא נדרש לעדכון של כל הרשומות בטבלה או בדוח: confirm_action: update_all.

ENTITY_ID

APP_ID

update_id

עליך לדעת את מזהה השדה שלך. אתה יכול למצוא מזהה באמצעות הקריאה אחזר את כל שדות הטופס.

update_term

ערך חדש לרשומות

view

כדי לקבל רשומות, עליך לדעת את מזהה הדוח. (לא בהכרח)

Making request (JSON)

פורמט

JSON

שיטה

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

תוכן הבקשה

{rest_api_key: "YOUR_KEY",
confirm_action: "update_all",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
update_id: "UPDATE_ID",
update_term: "UPDATE_TERM"}

תגובה

    
{\"success\":\"Done\"}

Making request (XML)

פורמט

XML

שיטה

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

תוכן הבקשה


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <confirm_action>update_all</confirm_action>
    <entity_id>ENTITY_ID</entity_id>
    <app_id>APP_ID</app_id>
    <update_id>UPDATE_ID</update_id>
    <update_term>UPDATE_TERM</update_term>
  </api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

עדכן נתוני תא

פרמטרים

rest_api_key

מפתח ה- API שלך

PROPERTY_ID

DTYPE_ID

val

הערך החדש של תא הנתונים

Making request (JSON)

פורמט

JSON

שיטה

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY", "property_id": "aNW4nkW5bdUjldO8oKuSku", "dtype_id": "cMW6pcTSjbWOFdTCkBtmkN", "val": "John Smith"}

תגובה

    
{"new_value": "John Smith"}

Making request (XML)

פורמט

XML

שיטה

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<val>John Smith</val> <rest_api_key>API_KEY</rest_api_key> <dtype-id>cMW6pcTSjbWOFdTCkBtmkN</dtype-id> <property-id>aNW4nkW5bdUjldO8oKuSku</property-id> </api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
<new_value>
John Smith
</new_value>

מחק רשומה

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

Making request (JSON)

פורמט

JSON

שיטה

DELETE

URL

/apps/APP_ID/dtypes/ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY"}

תגובה

    
{"record":
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"aNW4nkW5bdUjldO8oKuSku":"3",
"aMW4HKWR9bnOoGWQbpWQS4":"b",
"cMW6pcTSjbWOFdTCkBtmkN":"c"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
}

Making request (XML)

פורמט

XML

שיטה

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
<record>
  <id>bYWQnuBajdBOkAW4BdMmki</id>
  <app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
  <entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
  <values>
    <aNW4nkW5bdUjldO8oKuSku>3</aNW4nkW5bdUjldO8oKuSku>
    <aMW4HKWR9bnOoGWQbpWQS4>b</aMW4HKWR9bnOoGWQbpWQS4>
    <cMW6pcTSjbWOFdTCkBtmkN>c</cMW6pcTSjbWOFdTCkBtmkN>
  </values>
  <approved type="boolean">false</approved>
  <created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
  <updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>

מחק רשומות

פרמטרים

rest_api_key

מפתח ה- API שלך

ENTITY_ID

APP_ID

dtype_ids

עליך לדעת את מזהי הרשומות שלך. אתה יכול למצוא מזהה באמצעות שיחת אחזר כל הרשומות.

json_dtype_ids

עליך לדעת את מזהי הרשומות שלך. אתה יכול למצוא מזהה באמצעות שיחת אחזר כל הרשומות. (לא בהכרח)

Making request (JSON)

פורמט

JSON

שיטה

POST

URL

/apps/APP_ID/dtypes/delete_multiple.json

תוכן הבקשה

{rest_api_key: "YOUR_KEY",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
json_dtype_ids: "[\"ID1\",\"ID2\"...]"}

{rest_api_key: "YOUR_KEY",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
dtype_ids: ["ID1","ID2"...]}

תגובה

    
{\"success\":\"Done\"}

Making request (XML)

פורמט

XML

שיטה

POST

URL

/apps/APP_ID/dtypes/delete_multiple.xml

תוכן הבקשה


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <entity_id>ENTITY_ID</entity_id>
    <app_id>APP_ID</app_id>
    <json_dtype_ids>"[\"ID1\",\"ID2\"...]"</json_dtype_ids>
  </api_call_params>


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <entity_id>ENTITY_ID</entity_id>
    <app_id>APP_ID</app_id>
    <dtype_ids>"ID1","ID2"...</dtype_ids>
  </api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

מחק הכל

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

ENTITY_ID

view

כדי לקבל רשומות, עליך לדעת את מזהה הדוח. (לא בהכרח)

Making request (JSON)

פורמט

JSON

שיטה

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.json

תוכן הבקשה

{rest_api_key: "YOUR_KEY", entity_id: "ENTITY_ID"}

תגובה

    
{\"success\":\"Done\"}

Making request (XML)

פורמט

XML

שיטה

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.xml

תוכן הבקשה


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <entity_id>ENTITY_ID</entity_id>
  </api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

רשומה חדשה

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

ENTITY_ID

אם אתה צריך להשתמש במזהה האישי שלך, אתה יכול ליצור UUID (מזהה ייחודי) 22 תווים באורך בסיסי של URL בטוח 64 למשל ברובי . לאחר מכן תצטרך להעביר אותו לחשיש 'ערכים', למשל: ערכים => {'id' => ID}, שנה ל: values => {'id' => '22adadVXHdHie1WeGFE8k2'}, אחרת המערכת תייצר עבורך מזהה ייחודי.

values / json_values

subforms_values / subforms_json_values

Making request (JSON)

פורמט

JSON

שיטה

POST

URL

/apps/APP_ID/dtypes.json

תוכן הבקשה

{"rest_api_key":"API_KEY", "values": {"entity_id" : ENTITY_ID, "id" : ID, "aNW4nkW5bdUjldO8oKuSku":"3", "aMW4HKWR9bnOoGWQbpWQS4":"b","cMW6pcTSjbWOFdTCkBtmkN":"c"}}

תגובה: returns form information

    
{"record":
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"aNW4nkW5bdUjldO8oKuSku":"3",
"aMW4HKWR9bnOoGWQbpWQS4":"b",
"cMW6pcTSjbWOFdTCkBtmkN":"c"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
}

Making request (XML)

פורמט

XML

שיטה

POST

URL

/apps/APP_ID/dtypes.xml

תוכן הבקשה

<?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<values>{"aNW4nkW5bdUjldO8oKuSku"=>3,"entity_id"=>ENTITY_ID, "id"=>ID,"aMW4HKWR9bnOoGWQbpWQS4"=>"b", "cMW6pcTSjbWOFdTCkBtmkN"=>"c"}</values>< <rest_api_key>API_KEY</rest_api_key> </api_call_params>

תגובה: returns form information

    
<?xml version="1.0" encoding="UTF-8"?>
<record>
  <id>bYWQnuBajdBOkAW4BdMmki</id>
  <app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
  <entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
  <values>
    <aNW4nkW5bdUjldO8oKuSku>3</aNW4nkW5bdUjldO8oKuSku>
    <aMW4HKWR9bnOoGWQbpWQS4>b</aMW4HKWR9bnOoGWQbpWQS4>
    <cMW6pcTSjbWOFdTCkBtmkN>c</cMW6pcTSjbWOFdTCkBtmkN>
  </values>
  <approved type="boolean">false</approved>
  <created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
  <updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>

חיפוש

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

ENTITY_ID

view

כדי לקבל רשומות, עליך לדעת את מזהה הדוח. (לא בהכרח)

search

האם תרצה להעיף על השולחן? "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - מזהה של השדה שמאחורי היאק, מתבצעת נקודה ( -ALL - - עבור תקיעה בכל העמודות),
SEARCH_TERM - כלומר, יאק שוקאמו,
SEARCH_CRITERIA - קריטריון להודעה, אולי אחד מהם:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contains, not_contains.

למספרים ותאריכים רגילים : less_than, greater_than, less_than_or_equal_to, greater_than_or_equal_to.

לדייט של כשעה : before, after, this_day_and_before, this_day_and_after, yesterday, today, tomorrow, today_or_later, last_7_days, last_30_days,
last_60_days, last_90_days, last_120_days, next_7_days, next_30_days, next_60_days, next_90_days, next_120_days, next_n_days, last_n_days,
last_week, this_week, next_week, current_and_prev_week, current_and_next_week, next_n_weeks, last_n_weeks, last_month, this_month, next_month,
current_and_prev_month, current_and_next_month, next_n_months, last_n_months, last_year, this_year, last_2_years, next_2_years, current_and_prev_year,
current_and_next_year, next_n_years, last_n_years.

עמודות מערכת : added_by, created_at, updated_at, ip.

אם ברצונך לחפש בכמה עמודות עם קריטריון "AND" המאחד, יש למקם קריטריונים אלה במערך אחד, אם "או", ואז לאחד נפרד, למשל:
[[{"a" => "PROPERTY_ID_1", "b" => "A", "o" => "is"}, {"a" => "PROPERTY_ID_2", "b" => "A", "o" => "is"}],
[{"a" => "PROPERTY_ID_3", "b" => "B", "o" => "SEARCH_CRITERIA"}]]

נוסחת החיפוש תהיה: "Find all records where PROPERTY_ID_1 AND PROPERTY_ID_2 are equal to A OR PROPERTY_ID_3 is equal to B"

limit

מספר הרשומות בתוצאות החיפוש, המקסימום הוא 200.

Making request (JSON)

פורמט

JSON

שיטה

POST

URL

/search/APP_ID.json

תוכן הבקשה

{"rest_api_key":"API_KEY", "entity_id" => "ENTITY_ID", "search": [[{"a"=>"aNW4nkW5bdUjldO8oKuSku", "b"=>"value name 1", "o"=>"is"}]]}

תגובה

    
{"records":[
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"value name 1":"2",
"aNW4nkW5bdUjldO8oKuSku":"value name 1",
"value name 2":"aaa",
"aMW4HKWR9bnOoGWQbpWQS4":"value name 2",
"value name 3":"ddd",
"cMW6pcTSjbWOFdTCkBtmkN":"value name 3"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
},
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"value name 1":"2",
"aNW4nkW5bdUjldO8oKuSku":"value name 1",
"value name 2":"aaa",
"aMW4HKWR9bnOoGWQbpWQS4":"value name 2",
"value name 3":"ddd",
"cMW6pcTSjbWOFdTCkBtmkN":"value name 3"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
]
}

Związek

כיצד לקשר רשומות:

כדי ליצור קשר בין רשומות, עליך לשלוח hash נפרד בשאילתת הרשומה CREATE או UPDATE.

curl -H 'Type-type: application/json' -X PUT -d '{ "rel ": {REL_ID: RECORD_ID}} '"https://quintadb.com/apps/APP_ID/dtypes/CURRENT_RECORD_ID.json?rest_api_key=API_KEY "

האש חייב להיות בטופס 'rel' => {rel_id => RECORD_ID} או 'rel' => {rel_id => [RECORD_ID, RECORD_ID2]} אם יש לך קשר בין רבים לרבים איפה RECORD_ID - הוא מזהה הרשומה בה ברצונך לשלב את הנוכחי שיא. הנה כיצד להעביר rel_id.

פרמטרים

rest_api_key

מפתח ה- API שלך

PROPERTY_ID

ENTITY_ID

אתה צריך לדעת את מזהה הטופס. אתה יכול למצוא את ENTITY_ID לאחר קבלת כל הטפסים . לדעת את מזהה הטופס, עליך להחליף את ENTITY_ID בכתובת האתר, למשל /apps/APP_ID/entities/ENTITY_ID/properties.json ל- /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/propertiesson

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/entities/ENTITY_ID/get_rel_id/PROPERTY_ID.json?rest_api_key=API_KEY

תוכן הבקשה

{"rest_api_key":"API_KEY", {"entity_id" : ENTITY_ID, "property_id" : PROPERTY_ID}}

תגובה

דוחות

ניתן לגשת ל מאפייני דוחות כאלה באמצעות REST API.

name

שם

קבל דוחות

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

מזהה פרוייקט

ENTITY_ID

מזהה טבלה (טופס)

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/apps/APP_ID/entities/ENTITY_ID/views/index.json

תוכן הבקשה

{"rest_api_key":"API_KEY"}

תגובה: מחזירה את כל דוחות הטבלה.

    
{"reports":[
{"id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Report Name 1",
 "created_at"      : "2011-08-16T05:42:40-05:00",
 "updated_at"      : "2011-08-16T05:42:40-05:00",
 "entity_id"    : 'aEWQZdIXfahOqWvcvwrGTP',
 "app_id"  : 'ddIbpcNSncW5xcHxpdHCoW'
 },
{"id"              : "aOWO3eVXHdHie1WeGFE8k2"
 "name"            : "Report Name 2",
 "created_at"      : "2011-04-29T01:26:22-05:00",
 "updated_at"      : "2011-08-16T00:47:56-05:00",
 "entity_id"       : 'RtWQZdIXfahOqWvcvwrGTP',
 "app_id"          : 'ddIbpcNSncW5xcHxpdHCoW'
} ]}

Making request (XML)

פורמט

XML

שיטה

GET

URL

/apps/APP_ID/entities/ENTITY_ID/views/index.xml

תוכן הבקשה: מחזירה את כל דוחות הטבלה.

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

תגובה

    
<?xml version="1.0" encoding="UTF-8"?>
<reports type="array">
<report>
<id>bYWQnuBajdBOkAW4BdMmki</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
<updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>
<record>
<id>dcQSkdWO1odA5HAmkYWOix</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<created-at type="datetime">2011-09-17T04:28:10-05:00</created-at>
<updated-at type="datetime">2011-09-17T04:28:10-05:00</updated-at>
</report>
</reports>

קבצים

ראה קישור לקובץ

כדי לקבל את הקישור לקובץ, קבל תחילה את הערכים של שדות הרשומה ותוכל להוריד את הקובץ מהקישור https://quintadb.com/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME, שם FILE_NAME - שם הקובץ שהורד, התקבל ב- ערכי hashe מהסוג PROPERTY_ID => VALUE, RECORD_ID - מזהה רשומה, PROPERTY_ID - מזהה שדה.

הורד קבצים

על מנת להעלות קובץ לרשומה עליך להגיש בקשת POST לשיטת ה- API של upload_file עם כותרת מסוג תוכן מרובה חלקים / טופס ורק לאחר מכן עליך ליצור או לעדכן את הרשומה שלך. צריך להיווצר לפני השיחות. וגם תצטרך ליצור את הכותרת מרובת החלקים, אנא עקוב אחר הדוגמה של רובי עם הכיתה מרובת חלקים למטה. לדוגמא תלמד כיצד להעלות את הקובץ לטופס המשנה.

דוגמה לרובי

  
    require 'open-uri'
    require 'openssl'

    require 'net/http'
    require 'json'
    require 'securerandom'

    #MultipartPost
    class MultipartPost
      BOUNDARY = "-----------RubyMultipartPost"
      EOL = "\r\n"

      def initialize uri, &block
        @params = Array.new
        @uri = URI.parse uri
        instance_eval &block if block
      end

      def params_part key, value
        @params << multipart_text(key, value)
      end

      def files_part key, filename, mime_type, content
        @params << multipart_file(key, filename, mime_type, content)
      end

      def request_body
        body = @params.map{|p| "--#{BOUNDARY}#{EOL}" << p}.join ""
        body << "#{EOL}--#{BOUNDARY}--#{EOL}"
      end

      def run
        https = Net::HTTP.new @uri.host, @uri.port
        https.use_ssl = true
        https.verify_mode = (OpenSSL::SSL::VERIFY_PEER)
        request = Net::HTTP::Post.new @uri.request_uri
        request.body = request_body
        request.set_content_type "multipart/form-data", {"boundary" => BOUNDARY}
        res = https.request request
        res.body
      end

      private
      def multipart_text key, value
        content = "Content-Disposition: form-data; name=\"#{key}\"" <<
          EOL <<
          EOL <<
          "#{value}" << EOL
      end

      def multipart_file key, filename, mime_type, content
        content = "Content-Disposition: form-data; name=\"#{key}\"; filename=\"#{filename}\"#{EOL}" <<
          "Content-Type: #{mime_type}\r\n" <<
          EOL <<
          "#{content}" << EOL
      end
    end #MultipartPost

    def call_quinta(url, format, method, params={})
      uri = URI.parse(url)

      req = case method
              when "get"
                Net::HTTP::Get.new(uri.path) 
              when "post" 
                Net::HTTP::Post.new(uri.path)
              when "put"
                Net::HTTP::Put.new(uri.path)
              when "delete"
                Net::HTTP::Delete.new(uri.path)
            end

      req.body = case format
                  when "json"
                    JSON.generate(params)
                  else
                    "no"
                end
      
      req["Content-Type"] = "application/#{format}"

      https = Net::HTTP.new(uri.host, uri.port)

      https.use_ssl = (uri.scheme == 'https')
      https.verify_mode = (OpenSSL::SSL::VERIFY_PEER)

      https.start do |htt| 
        htt.request(req)
      end
    end

    dtype_id = SecureRandom.urlsafe_base64

    app_id   = "bsx8kgWR9jWOBdUftcRXf9"
    entity_id = "arjadcLJzeWOi1WPddL8ol"
    property_id = "bwW68wWP1cSikQqSkhl04I"

    post_url = "https://localhost:3001/entities/#{app_id}/upload_file/#{property_id}.json?dtype_id=#{dtype_id}"

    # Path to your file
    file_path = "/home/igor/Pictures/Selection_001.png"
    file = File.open file_path
    # getting file's content type, i.e. 'image/png'
    file_content_type =  `file --b --mime-type '#{file_path}'`.strip


    multi_part = MultipartPost.new post_url do
      params_part "rest_api_key", rest_api_key
      files_part "dtype[#{property_id}]", "Selection_001.png",
        file_content_type, file.read
    end
    p multi_part.run

    # And below is the example of how to upload the file to Subform
    rest_api_key          = "API_KEY"
    subform_field_id      = "dcL8kXB8npd5pdRmk7BCoR"
    subform_file_field_id = "aVWR3cNtvdUikQn8o3yCo1"
    subform_form_id       = "cCcxjdWRXpWPTLWOjvWPfO"
    subform_dtype_id      = SecureRandom.urlsafe_base64

    file_path = "/home/igor/Pictures/Selection_002.png"
    file = File.open file_path
    # getting file's content type, i.e. 'image/png'
    file_content_type =  `file --b --mime-type '#{file_path}'`.strip

    post_url = "https://quintadb.com/entities/#{app_id}/upload_file/#{subform_file_field_id}.json?dtype_id=#{subform_dtype_id}"

    # upload file into subform record
    multi_part = MultipartPost.new post_url do
      params_part "rest_api_key", rest_api_key
      params_part "subform_field", subform_field_id
      params_part "property_id", subform_file_field_id
      params_part "subform_dtype_id", subform_dtype_id
      files_part "subforms[#{subform_field_id}][#{subform_dtype_id}][#{subform_file_field_id}]", "Selection_002.png",
        file_content_type, file.read
    end
    p multi_part.run

    text_field_on_a_form = "agW6rGWQHiWPvdWPL0oCoj"
    text_field_on_a_subform = "dcV8k6y8nhWP4JF0r6W5LI"
    params = { 
      :page => 1,
      :rest_api_key => rest_api_key,  
      values: {entity_id: entity_id, id: dtype_id, text_field_on_a_form =>  "Test"},
      subforms: {subform_field_id => {entity_id: subform_form_id, subform_dtype_id => { text_field_on_a_subform => "Test2"}}}
    }
    response = call_quinta "https://quintadb.com/apps/#{app_id}/dtypes.json", "json", "post", params

    puts response.body

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

property_id

dtype_id

Making request (JSON)

פורמט

JSON

שיטה

POST

URL

/entities/APP_ID/upload_file/PROPERTY_ID.json?dtype_id=DTYPE_ID

תוכן הבקשה

{"rest_api_key"=>API_KEY, "filedata"="your_file_here", "dtype_id"=>"fRLA83jrnAUOi5TEQLyuGw", "app_id"=>"bsx8kgWR9jWOBdUftcRXf9"}

תגובה

    Uploaded

הסר קבצים

פרמטרים

rest_api_key

מפתח ה- API שלך

APP_ID

property_id

DTYPE_ID

SINGLE_FILE_NAME

שם קובץ

Making request (JSON)

פורמט

JSON

שיטה

GET

URL

/dtypes/delete_dtype_file/APP_ID/DTYPE_ID/PROPERTY_ID.json

תוכן הבקשה

{"rest_api_key"=>API_KEY, "single_file_name"=>"Selection_002.png", "app_id"=>"bsx8kgWR9jWOBdUftcRXf9", "dtype_id"=>"wlS5MeyMqQiCv16FdG3ztQ", "property_id"=>"bwW68wWP1cSikQqSkhl04I"}

תגובה

    File removed

דוגמאות

Ruby ~ Javascript (jQuery)

    	
require 'open-uri'
require 'openssl'

require 'net/http'
require 'json'

def call_mth(url, format, method, params={})
  uri = URI.parse(url)

	# Creating proper call with Method: GET/POST/PUT/DELETE
  req = case method
          when "get"
            Net::HTTP::Get.new(uri.path) 
          when "post" 
            Net::HTTP::Post.new(uri.path)
          when "put"
            Net::HTTP::Put.new(uri.path)
          when "delete"
            Net::HTTP::Delete.new(uri.path)
        end

   # המר פרמטרים ל- JSON/XML והגדר את סוג התוכן ליישום/json או יישום/xml   שים לב לפורמט של פרמטר XML בו אלמנט השורש הוא api_call_params  
  req.body = case format
              when "xml"
                "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
                  <api_call_params>
                    #{params.collect{|key, value| "<#{key}>#{value}"}.join("")}
                  </api_call_params>"
              when "json"
                JSON.generate(params)
              else
                "no"
            end
	# הגדר את סוג התוכן
  req["Content-Type"] = "application/#{format}"

  https = Net::HTTP.new(uri.host, uri.port)

  # כל חיבורי HTTPS ותעודות SSL נבדקים

  https.use_ssl = (uri.scheme == 'https')
  https.verify_mode = (OpenSSL::SSL::VERIFY_PEER)
	# Making request
  https.start do |htt| 
    htt.request(req)
  end
end


# זכור להגדיר API_KEY
params = { 
  :page => 1,
  :rest_api_key => "API_KEY"
}

response = call_mth "https://quintadb.ru/apps.json", "json", "get", params
# התגובה תהיה זמינה response.body
puts response.body

זהו ממשק API REST בסיסי והוא צריך להספיק כדי ליצור דברים מגניבים ושימושיים. עם זאת, אם אתה רוצה משהו אחר, למשל, שיטות נוספות וכו '. אנא צור קשר עלינו בכל עת. אנו תמיד שמחים לשמוע ממך!

QuintaDB REST API

מידע כללי על שיחות API

מסד נתונים

טופס

שדה

הקלט

דוחות

קבצים

אנו משתמשים בעוגיות כדי לספק את הפונקציונליות הדרושה לאתר. על ידי לחיצה על "קבל", אתה מסכים לשימוש בעוגיות באתר שלנו.